// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
//
// Author: wsfuyibing <682805@qq.com>
// Date: 2024-07-23

package src

import "fmt"

// Error
// is a component used to define an error struct.
type (
	Error struct {
		Code    int
		Message string
	}
	ErrorGetter interface {
		Code() int
		Message() string
	}
)

const (
	DefaultCodeInternal       = 1
	DefaultCodeUnknown        = 2
	DefaultCodeUnknownMessage = "unknown error"
)

// NewError
// creates a new error instance.
func NewError(code int, format string, args ...any) Error {
	return Error{Code: code, Message: fmt.Sprintf(format, args...)}
}

func (o Error) GetCode() int { return o.Code }

func (o Error) GetMessage() string { return o.Message }

func (o Error) Error() string { return fmt.Sprintf(`%d: %s`, o.Code, o.Message) }
